Global Index
HTML5 JS API Index > WebRTC Tutorials & Specs

RTCDataChannel

Extends EventTarget.

Properties
DOMString
binaryType
The binaryType attribute MUST, on getting, return the value to which it was last set. On setting, the user agent must set the IDL attribute to the new value. When a RTCDataChannel object is created, the binaryType attribute MUST be initialized to the string "blob".
unsigned long
bufferedAmount
The bufferedAmount attribute MUST return the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but that, as of the last time the event loop started executing a task, had not yet been transmitted to the network.
unsigned short
id
Overrides the default selection of id for this channel.
DOMString
label
The RTCDataChannel.label attribute represents a label that can be used to distinguish this RTCDataChannel object from other RTCDataChannel objects. The attribute MUST return the value to which it was set when the RTCDataChannel object was created.
unsigned int?
maxRetransmits
Limits the number of times a channel will retransmit data if not successfully delivered. This value may be clamped if it exceeds the maximum value supported by the user agent..
unsigned int?
maxRetransmitTime
Limits the time during which the channel will retransmit data if not successfully delivered. This value may be clamped if it exceeds the maximum value supported by the user agent.
boolean
negotiated
The default value of false tells the user agent to announce the channel in-band and instruct the other peer to dispatch a corresponding RTCDataChannel object. If set to true, it is up to the application to negotiate the channel and create a RTCDataChannel object with the same id at the other peer.
EventHandler
onclose
This event handler, of type close, MUST be supported by all objects implementing the RTCDataChannel interface.
EventHandler
onerror
This event handler, of type error, MUST be supported by all objects implementing the RTCDataChannel interface.
EventHandler
onmessage
This event handler, of type message ,MUST be supported by all objects implementing the RTCDataChannel interface.
EventHandler
onopen
This event handler, of type open, MUST be supported by all objects implementing the RTCDataChannel interface.
boolean
ordered
If set to false, data is allowed to be delivered out of order. The default value of true, guarantees that data will be delivered in order.
DOMString
protocol
Subprotocol name used for this channel.
RTCDataChannelState
readyState
The RTCDataChannel.readyState attribute represents the state of the RTCDataChannel object. It MUST return the value to which the user agent last set it (as defined by the processing model algorithms).
Operations
void
close()
Closes the RTCDataChannel. It may be called regardless of whether the RTCDataChannel object was created by this peer or the remote peer.
void
send(any data)
Run the steps described by the send() algorithm with argument type string object.
Referenced by
RTCDataChannelEventchannel
RTCDataChannelEventInitchannel
RTCPeerConnectioncreateDataChannel(...)